fix(autocomplete): type for 'title' prop in AutocompleteSection #3959

ritikpal1122 · 2024-10-29T06:19:08Z

📝 Description

This PR adds a type definition for the title prop in the AutocompleteSection component. This change enhances type safety and improves the developer experience by providing better autocompletion and error checking in TypeScript.

⛳️ Current behavior (updates)

Currently, the title prop in the AutocompleteSection component does not have a defined type, which can lead to potential runtime errors and confusion for developers using the component.

🚀 New behavior

With this PR, the title prop is now defined with a specific type, ensuring that it accepts only valid values. This change will help prevent errors and provide clearer documentation for developers.

💣 Is this a breaking change (Yes/No):

No

📝 Additional Information

This change was motivated by feedback from developers who encountered issues with the lack of type safety in the AutocompleteSection component.
Additional tests have been added to verify the correct behavior of the title prop.
Documentation has been updated to reflect the new type definition.

Summary by CodeRabbit

New Features
- Enhanced ListboxSectionBaseProps interface to include children and title properties for better customization in listbox sections.
- Updated SectionProps type to allow for more flexible omission of properties, improving component construction and customization options.
- | title | string | The title of the listbox section. | - |

changeset-bot · 2024-10-29T06:19:12Z

⚠️ No Changeset found

Latest commit: cfaed1a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-10-29T06:19:13Z

@ritikpal1122 is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2024-10-29T06:19:17Z

Walkthrough

The changes in this pull request involve updates to the ListboxSectionBaseProps interface and the SectionProps type. The ListboxSectionBaseProps now inherits from SectionProps with additional generic parameters for "children" and "title." The SectionProps type has also been modified to include a new generic parameter, OmitKeys, allowing for greater flexibility in omitting properties from the HTMLNextUIProps type. These modifications enhance the structure and usability of the listbox components.

Changes

File	Change Summary
packages/components/listbox/src/base/listbox-section-base.tsx	Updated `ListboxSectionBaseProps` to inherit from `SectionProps` with new generic parameters "children" and "title."
packages/utilities/aria-utils/src/collections/section.ts	Modified `SectionProps` type to include a third generic parameter `OmitKeys`, allowing omission of "children" and "title."

Assessment against linked issues

Objective	Addressed	Explanation
Fix type of 'title' prop in AutocompleteSection component (#3911)	✅

Possibly related PRs

fix: tsc error #3362: This PR addresses TypeScript compiler errors related to the @nextui-org/aria-utils package, which includes modifications to the SectionProps type that is extended in the ListboxSectionBaseProps interface in the main PR.
fix(autocomplete): highlight item in AutocompleteSection during keyboard navigation #3726: This PR modifies the useListboxItem function, which is likely related to the changes in the ListboxSectionBaseProps interface, as both are part of the listbox functionality in the NextUI library.
fix(autocomplete): exit animation on popover close #3845: This PR introduces changes to the Autocomplete component, which may interact with the ListboxSectionBase component, particularly in terms of rendering and user interaction, although it does not directly modify the same interfaces.

Suggested reviewers

wingkwong
jrgarciadev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 11af372 and cfaed1a.

📒 Files selected for processing (1)

packages/components/listbox/src/base/listbox-section-base.tsx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/components/listbox/src/base/listbox-section-base.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8de427b and 11af372.

📒 Files selected for processing (2)

packages/components/listbox/src/base/listbox-section-base.tsx (1 hunks)
packages/utilities/aria-utils/src/collections/section.ts (1 hunks)

🧰 Additional context used

🪛 Biome

packages/components/listbox/src/base/listbox-section-base.tsx

[error] 8-8: Don't use '{}' as a type.

Prefer explicitly define the object shape. '{}' means "any non-nullable value".

(lint/complexity/noBannedTypes)

packages/utilities/aria-utils/src/collections/section.ts

[error] 11-11: Don't use '{}' as a type.

Prefer explicitly define the object shape. '{}' means "any non-nullable value".

(lint/complexity/noBannedTypes)

🔇 Additional comments (2)

packages/utilities/aria-utils/src/collections/section.ts (1)

9-13: LGTM! Type enhancement improves flexibility and type safety.

The addition of the OmitKeys generic parameter with default values "children" | "title" provides better type control and aligns well with the PR's objective of improving type safety.

🧰 Tools

🪛 Biome

[error] 11-11: Don't use '{}' as a type.

Prefer explicitly define the object shape. '{}' means "any non-nullable value".

(lint/complexity/noBannedTypes)

packages/components/listbox/src/base/listbox-section-base.tsx (1)

8-9: LGTM! Good improvement in type safety.

The explicit type parameters for "children" and "title" in the SectionProps extension enhance type safety and provide better TypeScript support, which directly addresses the PR objective.

🧰 Tools

🪛 Biome

[error] 8-8: Don't use '{}' as a type.

Prefer explicitly define the object shape. '{}' means "any non-nullable value".

(lint/complexity/noBannedTypes)

packages/utilities/aria-utils/src/collections/section.ts

packages/components/listbox/src/base/listbox-section-base.tsx

ryo-manba

Thanks for the PR!
Please also update the documentation.

nextui/apps/docs/content/docs/components/listbox.mdx

Line 280 in 8de427b

    
           | title            | `string`                                                                                               | The title of the listbox section.                                                         | -       |

packages/utilities/aria-utils/src/collections/section.ts

wingkwong

please add a changeset.

feat: add type for 'title' prop in AutocompleteSection component

11af372

ritikpal1122 requested a review from jrgarciadev as a code owner October 29, 2024 06:19

coderabbitai bot reviewed Oct 29, 2024

View reviewed changes

packages/utilities/aria-utils/src/collections/section.ts Show resolved Hide resolved

packages/components/listbox/src/base/listbox-section-base.tsx Outdated Show resolved Hide resolved

wingkwong changed the title ~~feat: add type for 'title' prop in AutocompleteSection component~~ fix(autocomplete): type for 'title' prop in AutocompleteSection Oct 29, 2024

refactor: improve type safety in ListboxSectionBaseProps

cfaed1a

ryo-manba requested changes Oct 30, 2024

View reviewed changes

packages/utilities/aria-utils/src/collections/section.ts Show resolved Hide resolved

ritikpal1122 closed this Nov 7, 2024

ritikpal1122 reopened this Nov 7, 2024

wingkwong requested changes Nov 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(autocomplete): type for 'title' prop in AutocompleteSection #3959

fix(autocomplete): type for 'title' prop in AutocompleteSection #3959

ritikpal1122 commented Oct 29, 2024 •

edited

Loading

changeset-bot bot commented Oct 29, 2024 •

edited

Loading

vercel bot commented Oct 29, 2024

coderabbitai bot commented Oct 29, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

ryo-manba left a comment

wingkwong left a comment

fix(autocomplete): type for 'title' prop in AutocompleteSection #3959

Are you sure you want to change the base?

fix(autocomplete): type for 'title' prop in AutocompleteSection #3959

Conversation

ritikpal1122 commented Oct 29, 2024 • edited Loading

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

Summary by CodeRabbit

changeset-bot bot commented Oct 29, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Oct 29, 2024

coderabbitai bot commented Oct 29, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

ryo-manba left a comment

Choose a reason for hiding this comment

wingkwong left a comment

Choose a reason for hiding this comment

ritikpal1122 commented Oct 29, 2024 •

edited

Loading

changeset-bot bot commented Oct 29, 2024 •

edited

Loading

coderabbitai bot commented Oct 29, 2024 •

edited

Loading